JavaScript modulio federacijos vykdymo laiko registras: dinaminis modulių atradimas

Modulių federacija, galinga Webpack 5 pristatyta funkcija, pakeitė mūsų požiūrį į JavaScript programų kūrimą ir diegimą, ypač mikrofrontendų srityje. Ji leidžia skirtingoms, savarankiškai sukurtoms ir diegiamoms programoms, vykdymo metu dalintis kodu ir funkcionalumu. Nors statinės modulių federacijos konfigūracijos yra įprastos, tikroji galia slypi dinaminiame modulių atradime, naudojant vykdymo laiko registrą. Šis straipsnis gilinasi į vykdymo laiko registro koncepciją modulių federacijai, nagrinėdamas jo diegimą, privalumus ir pažangius naudojimo atvejus.

Kas yra vykdymo laiko registras?

Modulių federacijos kontekste vykdymo laiko registras veikia kaip centrinis katalogas arba paslauga, teikianti informaciją apie prieinamus nuotolinius modulius. Vietoj to, kad nuotolinių modulių vietos būtų griežtai nurodomos jūsų programos konfigūracijoje, jūs kreipiatės į registrą vykdymo metu, kad atrastumėte ir įkeltumėte reikiamus modulius. Šis dinaminis požiūris siūlo keletą privalumų:

• Atskyrimas: Programos yra mažiau glaudžiai susietos su konkrečiomis nuotolinių modulių versijomis ar vietomis.
• Keičiamo dydžio: Lengviau pridėti, pašalinti ar atnaujinti nuotolinius modulius, nereikėtų iš naujo diegti vartojančių programų.
• Prisitaikomumas: Leidžia dinamiškai perjungti funkcijas ir atlikti A/B testavimą, teikiant skirtingus modulius, atsižvelgiant į vykdymo sąlygas.
• Atsparumas: Jei vienas nuotolinis modulis nepasiekiamas, registras gali pateikti alternatyvią vietą ar versiją.

Kodėl verta naudoti vykdymo laiko registrą?

Įsivaizduokite didelę el. prekybos platformą, sudarytą iš kelių mikrofrontendų, tokių kaip prekių katalogas, pirkinių krepšelis ir naudotojų paskyros. Kiekvienas mikrofrontendas yra kuriamas ir diegiamas savarankiškai. Be vykdymo laiko registro, kiekvienas mikrofrontendas turėtų žinoti tikslią bet kokių bendrinamų modulių ar komponentų, naudojamų kitų mikrofrontendų, vietą ir versiją. Tai sukuria stiprų susiejimą ir apsunkina atnaujinimus. Pavyzdžiui, bendrinamo UI komponento atnaujinimas reikštų visų nuo jo priklausomų mikrofrontendų iš naujo diegimą.

Tačiau su vykdymo laiko registru mikrofrontendai tiesiog kreipiasi į registrą dėl reikalingo komponento vietos ir versijos. Tada registras gali pateikti atitinkamą informaciją, leidžiančią mikrofrontendams dinamiškai įkelti komponentą. Šis atskyrimas leidžia atlikti nepriklausomus atnaujinimus ir sumažina lūžtančių pakeitimų riziką.

Vykdymo laiko registro diegimas

Yra keletas būdų, kaip įdiegti vykdymo laiko registrą, pradedant paprastais JSON failais ir baigiant sudėtingesnėmis paslaugomis su versijavimo ir maršrutizavimo galimybėmis. Štai pagrindinis pavyzdys, naudojant paprastą JSON failą, talpinamą žiniatinklio serveryje:

1. Registro apibrėžimas (registry.json):

{
  "modules": {
    "@my-org/product-card": {
      "1.0.0": "https://cdn.example.com/product-card/1.0.0/remoteEntry.js",
      "1.1.0": "https://cdn.example.com/product-card/1.1.0/remoteEntry.js"
    },
    "@my-org/checkout-button": {
      "2.0.0": "https://cdn.example.com/checkout-button/2.0.0/remoteEntry.js"
    }
  }
}

Šis JSON failas apibrėžia prieinamus modulius ir jų atitinkamus URL. Kiekvienas modulis turi versijuotus įrašus, nukreipiančius į atitinkamus `remoteEntry.js` failus. Tai leidžia valdyti versijas ir lengvai grąžinti ankstesnę versiją, jei reikia.

2. Naudojanti programa:

async function loadRemote(moduleName, version) {
  const registryUrl = 'https://example.com/registry.json';
  const response = await fetch(registryUrl);
  const registry = await response.json();

  const moduleInfo = registry.modules[moduleName];
  if (!moduleInfo) {
    throw new Error(`Modulis "${moduleName}" nerastas registre.`);
  }

  const moduleUrl = moduleInfo[version];
  if (!moduleUrl) {
    throw new Error(`Versija "${version}" moduliui "${moduleName}" nerasta.`);
  }

  return new Promise((resolve, reject) => {
    const script = document.createElement('script');
    script.src = moduleUrl;
    script.type = 'text/javascript';
    script.async = true;
    script.onload = () => {
      // Modulis įkeltas, dabar galite jį pasiekti naudodami window[moduleName]
      resolve(window[moduleName]);
    };
    script.onerror = (error) => {
      console.error(`Klaida įkeliant modulį ${moduleName} iš ${moduleUrl}:`, error);
      reject(error);
    };
    document.head.appendChild(script);
  });
}

// Naudojimo pavyzdys:
loadRemote('@my-org/product-card', '1.0.0')
  .then((module) => {
    // Naudokite įkeltą modulį
    const ProductCard = module.ProductCard;
    const productCardInstance = new ProductCard({ name: 'Pavyzdinis produktas' });
    document.getElementById('product-card-container').appendChild(productCardInstance.render());
  })
  .catch((error) => {
    console.error('Nepavyko įkelti produkto kortelės:', error);
  });

Šis kodo fragmentas demonstruoja, kaip gauti registrą, rasti norimą modulį ir versiją bei dinamiškai įkelti nuotolinį įrašą. Jame taip pat yra pagrindinis klaidų tvarkymas.

3. Webpack konfigūracija (nuotolinė programa):

const { ModuleFederationPlugin } = require('webpack').container;

module.exports = {
  //...
  plugins: [
    new ModuleFederationPlugin({
      name: '@my-org/product-card',
      filename: 'remoteEntry.js',
      exposes: {
        './ProductCard': './src/ProductCard',
      },
      // shared: { ... }, // Bendrinamos priklausomybės
    }),
  ],
};

Tai yra standartinė Module Federation Webpack konfigūracija nuotolinei programai, eksponuojančiai `ProductCard` komponentą. Svarbiausia čia, kad `filename` yra `remoteEntry.js`, kuris yra registre nurodytas failas.

Pažangūs naudojimo atvejai

Paprastą aukščiau pateiktą pavyzdį galima išplėsti, kad būtų galima valdyti sudėtingesnius scenarijus:

Versijų valdymas

Registre galima saugoti kelias kiekvieno modulio versijas, leidžiančias vartojančioms programoms nurodyti norimą versiją. Tai labai svarbu norint išlaikyti suderinamumą ir leisti laipsniškus atnaujinimus.

Pavyzdys: Registras gali turėti versijos informaciją, o vartojanti programa gali prašyti konkrečios versijos arba priimtinų versijų diapazono (pvz., '>=1.0.0 <2.0.0'). Tada registras gali grąžinti atitinkamą URL pagal užklausą.

Maršrutizavimas ir apkrovos balansavimas

Registras gali veikti kaip apkrovos balansavimo priemonė, nukreipianti užklausas į skirtingus serverius, atsižvelgiant į prieinamumą ar geografinę vietą. Tai gali pagerinti našumą ir patikimumą.

Pavyzdys: Registras gali turėti kelis URL to paties modulio, o kiekvienas URL nukreipia į skirtingą CDN arba serverį. Tada registras gali naudoti apkrovos balansavimo algoritmą, kad paskirstytų užklausas tarp prieinamų serverių.

Autentifikavimas ir autorizavimas

Registras gali įgyvendinti autentifikavimo ir autorizavimo politikas, užtikrindamas, kad tik autorizuotos programos galėtų pasiekti konkrečius modulius. Tai būtina norint apsaugoti jautrų kodą ir duomenis.

Pavyzdys: Registras gali reikalauti API rakto arba žetono, kad būtų galima pasiekti modulio informaciją. Vartojančiai programai reikės pateikti teisingus kredencialus, kad gautų modulio URL.

Funkcijų perjungikliai

Registras gali būti naudojamas funkcijų perjungikliai įdiegti, leidžiančioms dinamiškai įjungti arba išjungti funkcijas, nereikėtų iš naujo diegti programų. Tai naudinga A/B testavimui ir laipsniškam naujų funkcijų diegimui.

Pavyzdys: Registras gali turėti skirtingas konfigūracijas skirtingoms aplinkoms ar vartotojų grupėms. Atsižvelgiant į vartotojo tapatybę ar dabartinio puslapio kontekstą, registras gali grąžinti skirtingus URL to paties modulio, efektyviai įjungdamas arba išjungdamas tam tikras funkcijas.

Dinaminė modulių kompozicija

Registras gali palengvinti dinaminę modulių kompoziciją, kai vykdymo metu įkeliami moduliai priklauso nuo vykdymo sąlygų arba vartotojo sąveikos. Tai leidžia kurti labai prisitaikančias ir personalizuotas programas.

Pavyzdys: Atsižvelgiant į vartotojo nuostatas arba dabartinio puslapio kontekstą, programa gali kreiptis į registrą dėl tinkamų įkelti modulių. Tai leidžia labai individualizuoti vartotojo patirtį.

Svarstymai ir geriausios praktikos

Nors vykdymo laiko registras siūlo didelius privalumus, būtina atsižvelgti į šiuos veiksnius:

• Našumas: Informacijos gavimas iš registro prideda papildomą tinklo užklausą. Apsvarstykite registro duomenų talpinimą, kad sumažintumėte delsą.
• Sudėtingumas: Vykdymo laiko registro diegimas ir priežiūra padidina jūsų architektūros sudėtingumą. Prieš pritaikydami šį metodą, atidžiai įvertinkite kompromisus.
• Saugumas: Apsaugokite registrą nuo neteisėtos prieigos ir modifikavimo. Įdiekite atitinkamus autentifikavimo ir autorizavimo mechanizmus.
• Klaidų tvarkymas: Įdiekite patikimą klaidų tvarkymą, kad būtų galima tinkamai valdyti atvejus, kai registras nepasiekiamas arba modulis negali būti įkeltas.
• Keičiamo dydžio: Užtikrinkite, kad registras galėtų apdoroti numatomą apkrovą ir didėti augant jūsų programai. Apsvarstykite galimybę naudoti paskirstytą duomenų bazę arba talpyklos sluoksnį, kad pagerintumėte našumą.
• Centralizuotas valdymas: Įdiekite tinkamus registro valdymo ir pokyčių valdymo procesus, kad užtikrintumėte nuoseklumą ir išvengtumėte konfliktų.
• Stebėjimas: Stebėkite registro veikimą ir prieinamumą, kad proaktyviai nustatytumėte ir išspręstumėte problemas.

Alternatyvos paprastam JSON registrui

Nors paprastas JSON failas yra gera pradžia, gamybos aplinkoms dažnai reikalingi patikimesni sprendimai. Apsvarstykite šias alternatyvas:

• Individuali API paslauga: Skirta API paslauga, sukurta su Node.js, Python ar Go, suteikia didesnį lankstumą ir registro logikos valdymą. Tai leidžia naudoti tokias funkcijas kaip autentifikavimas, autorizavimas, versijų valdymas ir apkrovos balansavimas.
• Paslaugų atradimo įrankiai (pvz., Consul, etcd, ZooKeeper): Šie įrankiai skirti paslaugų konfigūracijų valdymui ir dinamiškam paslaugų atradimui. Jie gali būti naudojami modulių federacijos registro duomenims saugoti ir valdyti.
• Debesų pagrindo konfigūracijos paslaugos (pvz., AWS AppConfig, Azure App Configuration, Google Cloud Config): Šios paslaugos teikia centralizuotą ir keičiamo dydžio būdą valdyti programų konfigūracijas, įskaitant modulių federacijos registrą.
• Esamos mikroservisų orkestravimo platformos (pvz., Kubernetes): Jei jau naudojate mikroservisų orkestravimo platformą, galite pasinaudoti jos integruotomis paslaugų atradimo ir konfigūracijos valdymo funkcijomis modulių federacijos registrui.

Pavyzdys: Pasaulinė el. prekybos platforma

Įsivaizduokite pasaulinę el. prekybos platformą su parduotuvėmis keliose šalyse. Kiekviena šalis gali turėti skirtingus prekių katalogus, mokėjimo būdus ir pristatymo galimybes. Vykdymo laiko registras gali būti naudojamas dinamiškai įkelti atitinkamus modulius, atsižvelgiant į vartotojo vietą ir nuostatas.

Pavyzdžiui, vartotojas Vokietijoje gali matyti prekių katalogą su vokiečių kalbos aprašymais ir kainomis eurais, o vartotojas Japonijoje – prekių katalogą su japonų kalbos aprašymais ir kainomis jenomis. Vykdymo laiko registras nustatytų, kuriuos modulius įkelti, atsižvelgiant į vartotojo vietą ir nuostatas.

Be to, mokėjimo modulis galėtų būti dinamiškai pasirenkamas atsižvelgiant į vartotojo vietą. Vartotojai Vokietijoje galėtų matyti mokėjimo galimybes per PayPal arba kredito kortelę, o vartotojai Japonijoje – mokėjimo galimybes per kredito kortelę arba mokėjimą parduotuvėje.

Tokio lygio dinaminį pritaikymą sunku pasiekti be vykdymo laiko registro.

Išvada

Vykdymo laiko registras yra galingas įrankis, leidžiantis dinamiškai atrasti modulius JavaScript modulių federacijoje. Jis siūlo keletą privalumų, įskaitant atskyrimą, keičiamo dydžio, prisitaikomumą ir atsparumą. Nors vykdymo laiko registro diegimas padidina jūsų architektūros sudėtingumą, privalumai dažnai nusveria išlaidas, ypač didelėms ir sudėtingoms programoms. Atidžiai apsvarstę šiame straipsnyje aprašytus veiksnius, galite sėkmingai įdiegti vykdymo laiko registrą ir išnaudoti visą modulių federacijos potencialą.

Kadangi mikrofrontendų architektūra toliau vystosi, vykdymo laiko registras atliks vis svarbesnį vaidmenį, leidžiantį kurti keičiamo dydžio ir prisitaikančias žiniatinklio programas. Priimkite šią technologiją ir kurkite ateities sąsajos kūrimą.